- NAME
-
- gcloud config list - list Google Cloud CLI properties for the currently active configuration
- SYNOPSIS
- DESCRIPTION
-
gcloud config list lists the properties of the specified section using the
active configuration. These include the account used to authorize access to
Google Cloud, the current Google Cloud project, and the default Compute Engine
region and zone, if set. See
gcloud topic configurationsfor more about configurations. - EXAMPLES
-
To list the set project property in the core section, run:
gcloud config list projectTo list the set zone property in the compute section, run:
gcloud config list compute/zoneTo list all the set properties in the compute section, run:
gcloud config list compute/To list all the properties in the compute section, run:
gcloud config list compute/ --allTo list all the properties, run:
gcloud config list --allNote, you cannot specify both
--alland a property name. Only a section name and the--allflag can be used together in the formatgcloud config list <SECTION>/ --all. - POSITIONAL ARGUMENTS
-
- [
SECTION/PROPERTY] - Property to be listed. Note that SECTION/ is optional while referring to properties in the core section.
- [
- FLAGS
-
--all- List all set and unset properties that match the arguments.
- LIST COMMAND FLAGS
-
--filter=EXPRESSION-
Apply a Boolean filter
EXPRESSIONto each resource item to be listed. If the expression evaluatesTrue, then that item is listed. For more details and examples of filter expressions, run $ gcloud topic filters. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --limit=LIMIT-
Maximum number of resources to list. The default is
unlimited. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --sort-by=[FIELD,…]-
Comma-separated list of resource field key names to sort by. The default order
is ascending. Prefix a field with ``~´´ for descending order on that
field. This flag interacts with other flags that are applied in this order:
--flatten,--sort-by,--filter,--limit.
- GCLOUD WIDE FLAGS
-
These flags are available to all commands:
--access-token-file,--account,--billing-project,--configuration,--flags-file,--flatten,--format,--help,--impersonate-service-account,--log-http,--project,--quiet,--trace-token,--user-output-enabled,--verbosity.Run
$ gcloud helpfor details. - AVAILABLE PROPERTIES
-
core-
account-
Account
gcloudshould use for authentication. Rungcloud auth listto see your currently available accounts. console_log_format-
Control the format used to display log messages to the console.
Valid values are:
-
standard- Simplified log messages are displayed on the console. -
detailed- More detailed messages are displayed on the console.
If unset, default is
standard. -
custom_ca_certs_file- Absolute path to a custom CA cert file.
default_format-
Sets the default format for printing command resources.
core/default_formatoverrides the default yaml format. If the command contains a command-specific output format, it takes precedence over thecore/default_formatvalue. Use--verbosity=debugflag to view the command-specific format. Bothcore/formatand--formatalso take precedence overcore/default_format. The supported formats are limited to:config,default,disable,flattened,json,list,none,object,text. For more details run $ gcloud topic formats. Run$ gcloud config set --helpto see more information aboutcore/default_format default_regional_backend_service-
If True, backend services in
gcloud compute backend-serviceswill be regional by default. Setting the--globalflag is required for global backend services. disable_color- If True, color will not be used when printing messages in the terminal.
disable_file_logging-
If True,
gcloudwill not store logs to a file. This may be useful if disk space is limited. disable_prompts-
If True, the default answer will be assumed for all user prompts. However, for
any prompts that require user input, an error will be raised. This is equivalent
to either using the global
--quietflag or setting the environment variableCLOUDSDK_CORE_DISABLE_PROMPTSto 1. Setting this property is useful when scripting withgcloud. disable_usage_reporting- If True, anonymous statistics on SDK usage will not be collected. This value is set by your choices during installation, but can be changed at any time. For more information, see Usage statistics.
enable_feature_flags- If True, remote config-file driven feature flags will be enabled.
format-
Sets the format for printing all command resources. This overrides the default
command-specific human-friendly output format. Use
--verbosity=debugflag to view the command-specific format. If bothcore/default_formatandcore/formatare specified,core/formattakes precedence. If bothcore/formatand--formatare specified,--formattakes precedence. The supported formats are limited to:config,default,disable,flattened,json,list,none,object,text. For more details run $ gcloud topic formats. Run$ gcloud config set --helpto see more information aboutcore/format log_http-
If True, log HTTP requests and responses to the logs. To see logs in the
terminal, adjust
verbositysettings. Otherwise, logs are available in their respective log files. max_log_days- Maximum number of days to retain log files before deleting. If set to 0, turns off log garbage collection and does not delete log files. If unset, the default is 30 days.
parse_error_details-
If True,
gcloudwill attempt to parse and interpret error details in API originating errors. If False,gcloudwill write flush error details as is to stderr/log. pass_credentials_to_gsutil- If True, pass the configured Google Cloud CLI authentication to gsutil.
project-
Project ID of the Cloud Platform project to operate on by default. This can be
overridden by using the global
--projectflag. show_structured_logs-
Control when JSON-structured log messages for the current verbosity level (and
above) will be written to standard error. If this property is disabled, logs are
formatted as
textby default.Valid values are:
-
never- Log messages as text -
always- Always log messages as JSON -
log- Only log messages as JSON if stderr is a file -
terminal- Only log messages as JSON if stderr is a terminal
If unset, default is
never. -
trace_token- Token used to route traces of service requests for investigation of issues. This token will be provided by Google support.
user_output_enabled- True, by default. If False, messages to the user and command output on both standard output and standard error will be suppressed.
verbosity-
Default logging verbosity for
gcloudcommands. This is the equivalent of using the global--verbosityflag. Supported verbosity levels:debug,info,warning,error,critical, andnone.
accessibility-
screen_reader- Make gcloud more screen reader friendly.
ai-
region-
Default region to use when working with AI Platform resources. When a
--regionflag is required but not provided, the command will fall back to this value, if set.
ai_platform-
region-
Default region to use when working with AI Platform Training and Prediction
resources (currently for Prediction only). It is ignored for training resources
for now. The value should be either
globalor one of the supported regions. When a--regionflag is required but not provided, the command will fall back to this value, if set.
api_endpoint_overrides-
accessapproval-
Overrides API endpoint for
gcloud access-approvalcommand group. Defaults to https://accessapproval.googleapis.com/ accesscontextmanager-
Overrides API endpoint for
gcloud access-context-managercommand group. Defaults to https://accesscontextmanager.googleapis.com/ ai-
Overrides API endpoint for
gcloud aicommand group. aiplatform-
Overrides API endpoint for
gcloud ai-platformcommand group. Defaults to https://aiplatform.googleapis.com/ anthosevents-
Overrides API endpoint for
gcloud anthoscommand group. Defaults to https://anthosevents.googleapis.com/ anthospolicycontrollerstatus_pa-
Overrides API endpoint for
gcloud container fleet policycontrollercommand group. Defaults to https://anthospolicycontrollerstatus-pa.googleapis.com/ apigateway-
Overrides API endpoint for
gcloud api-gatewaycommand group. Defaults to https://apigateway.googleapis.com/ apigee-
Overrides API endpoint for
gcloud apigeecommand group. Defaults to https://apigee.googleapis.com/ appengine-
Overrides API endpoint for
gcloud appcommand group. Defaults to https://appengine.googleapis.com/ artifactregistry-
Overrides API endpoint for
gcloud artifactscommand group. Defaults to https://artifactregistry.googleapis.com/ assuredworkloads-
Overrides API endpoint for
gcloud assuredcommand group. Defaults to https://assuredworkloads.googleapis.com/ baremetalsolution-
Overrides API endpoint for
gcloud bmscommand group. Defaults to https://baremetalsolution.googleapis.com/ bigtableadmin-
Overrides API endpoint for
gcloud bigtablecommand group. Defaults to https://bigtableadmin.googleapis.com/ certificatemanager-
Overrides API endpoint for
gcloud certificate-managercommand group. Defaults to https://certificatemanager.googleapis.com/ cloudasset-
Overrides API endpoint for
gcloud assetcommand group. Defaults to https://cloudasset.googleapis.com/ cloudbilling-
Overrides API endpoint for
gcloud billingcommand group. Defaults to https://cloudbilling.googleapis.com/ cloudbuild-
Overrides API endpoint for
gcloud buildscommand group. Defaults to https://cloudbuild.googleapis.com/ cloudcommerceconsumerprocurement-
Overrides API endpoint for
gcloud commerce-procurementcommand group. Defaults to https://cloudcommerceconsumerprocurement.googleapis.com/ clouddebugger-
Overrides API endpoint for
gcloud debugcommand group. Defaults to https://clouddebugger.googleapis.com/ clouddeploy-
Overrides API endpoint for
gcloud deploycommand group. Defaults to https://clouddeploy.googleapis.com/ clouderrorreporting-
Overrides API endpoint for
gcloud error-reportingcommand group. Defaults to https://clouderrorreporting.googleapis.com/ cloudfunctions-
Overrides API endpoint for
gcloud functionscommand group. Defaults to https://cloudfunctions.googleapis.com/ cloudidentity-
Overrides API endpoint for
gcloud identitycommand group. Defaults to https://cloudidentity.googleapis.com/ cloudiot-
Overrides API endpoint for
gcloud iotcommand group. Defaults to https://cloudiot.googleapis.com/ cloudkms-
Overrides API endpoint for
gcloud kmscommand group. Defaults to https://cloudkms.googleapis.com/ cloudresourcemanager-
Overrides API endpoint for
gcloud projectscommand group. Defaults to https://cloudresourcemanager.googleapis.com/ cloudscheduler-
Overrides API endpoint for
gcloud schedulercommand group. Defaults to https://cloudscheduler.googleapis.com/ cloudtasks-
Overrides API endpoint for
gcloud taskscommand group. Defaults to https://cloudtasks.googleapis.com/ cloudtrace-
Overrides API endpoint for
gcloud tracecommand group. Defaults to https://cloudtrace.googleapis.com/ composer-
Overrides API endpoint for
gcloud composercommand group. Defaults to https://composer.googleapis.com/ compute-
Overrides API endpoint for
gcloud computecommand group. For Private Service Connect usage, see https://cloud.google.com/vpc/docs/configure-private-service-connect-apis#using-endpoints config-
Overrides API endpoint for
gcloud blueprintscommand group. Defaults to https://config.googleapis.com/ container-
Overrides API endpoint for
gcloud containercommand group. Defaults to https://container.googleapis.com/ datacatalog-
Overrides API endpoint for
gcloud data-catalogcommand group. Defaults to https://datacatalog.googleapis.com/ dataflow-
Overrides API endpoint for
gcloud dataflowcommand group. Defaults to https://dataflow.googleapis.com/ datafusion-
Overrides API endpoint for
gcloud data-fusioncommand group. Defaults to https://datafusion.googleapis.com/ datamigration-
Overrides API endpoint for
gcloud database-migrationcommand group. Defaults to https://datamigration.googleapis.com/ datapipelines-
Overrides API endpoint for
gcloud datapipelinescommand group. Defaults to https://datapipelines.googleapis.com/ dataplex-
Overrides API endpoint for
gcloud dataplexcommand group. Defaults to https://dataplex.googleapis.com/ dataproc-
Overrides API endpoint for
gcloud dataproccommand group. Defaults to https://dataproc.googleapis.com/ datastore-
Overrides API endpoint for
gcloud datastorecommand group. Defaults to https://datastore.googleapis.com/ datastream-
Overrides API endpoint for
gcloud datastreamcommand group. Defaults to https://datastream.googleapis.com/ deploymentmanager-
Overrides API endpoint for
gcloud deployment-managercommand group. Defaults to https://deploymentmanager.googleapis.com/ dns-
Overrides API endpoint for
gcloud dnscommand group. Defaults to https://dns.googleapis.com/dns/v1/ domains-
Overrides API endpoint for
gcloud domainscommand group. Defaults to https://domains.googleapis.com/ edgecontainer-
Overrides API endpoint for
gcloud edge-containercommand group. Defaults to https://edgecontainer.googleapis.com/ eventarc-
Overrides API endpoint for
gcloud eventarccommand group. Defaults to https://eventarc.googleapis.com/ eventarcpublishing-
Overrides API endpoint for
gcloud eventarc publishcommand group. Defaults to https://eventarcpublishing.googleapis.com/ events-
Overrides API endpoint for
gcloud eventscommand group. Defaults to https://events.googleapis.com/ file-
Overrides API endpoint for
gcloud filestorecommand group. Defaults to https://file.googleapis.com/ firestore-
Overrides API endpoint for
gcloud firestorecommand group. Defaults to https://firestore.googleapis.com/ gameservices-
Overrides API endpoint for
gcloud gamercommand group. Defaults to https://gameservices.googleapis.com/ genomics-
Overrides API endpoint for
gcloud genomicscommand group. Defaults to https://genomics.googleapis.com/ gkemulticloud-
Overrides API endpoint for
gcloud container aws,gcloud container azureandgcloud container attachedcommand groups. healthcare-
Overrides API endpoint for
gcloud healthcarecommand group. Defaults to https://healthcare.googleapis.com/ iam-
Overrides API endpoint for
gcloud iamcommand group. Defaults to https://iam.googleapis.com/ iap-
Overrides API endpoint for
gcloud iapcommand group. Defaults to https://iap.googleapis.com/ ids-
Overrides API endpoint for
gcloud idscommand group. Defaults to https://ids.googleapis.com/ krmapihosting-
Overrides API endpoint for
gcloud anthos config controllercommand group. Defaults to https://krmapihosting.googleapis.com/ language-
Overrides API endpoint for
gcloud ml languagecommand group. Defaults to https://language.googleapis.com/ lifesciences-
Overrides API endpoint for
gcloud lifesciencescommand group. Defaults to https://lifesciences.googleapis.com/ logging-
Overrides API endpoint for
gcloud loggingcommand group. Defaults to https://logging.googleapis.com/ looker-
Overrides API endpoint for
gcloud lookercommand group. Defaults to https://looker.googleapis.com/ managedidentities-
Overrides API endpoint for
gcloud active-directorycommand group. Defaults to https://managedidentities.googleapis.com/ mediaasset-
Overrides API endpoint for
gcloud mediacommand group. Defaults to https://mediaasset.googleapis.com/ memcache-
Overrides API endpoint for
gcloud memcachecommand group. Defaults to https://memcache.googleapis.com/ metastore-
Overrides API endpoint for
gcloud metastorecommand group. Defaults to https://metastore.googleapis.com/ monitoring-
Overrides API endpoint for
gcloud monitoringcommand group. Defaults to https://monitoring.googleapis.com/ netapp-
Overrides API endpoint for
gcloud netappcommand group. Defaults to https://netapp.googleapis.com/ networkconnectivity-
Overrides API endpoint for
gcloud network-connectivitycommand group. Defaults to https://networkconnectivity.googleapis.com/ networkmanagement-
Overrides API endpoint for
gcloud network-managementcommand group. Defaults to https://networkmanagement.googleapis.com/ networksecurity-
Overrides API endpoint for
gcloud network-securitycommand group. Defaults to https://networksecurity.googleapis.com/ networkservices-
Overrides API endpoint for
gcloud network-servicescommand group. Defaults to https://networkservices.googleapis.com/ notebooks-
Overrides API endpoint for
gcloud notebookscommand group. Defaults to https://notebooks.googleapis.com/ orgpolicy-
Overrides API endpoint for
gcloud org-policiescommand group. Defaults to https://orgpolicy.googleapis.com/ policyanalyzer-
Overrides API endpoint for
policy-intelligencecommand group. Defaults to https://policyanalyzer.googleapis.com/ privateca-
Overrides API endpoint for
gcloud privatecacommand group. Defaults to https://privateca.googleapis.com/ publicca-
Overrides API endpoint for
gcloud publiccacommand group. Defaults to https://publicca.googleapis.com/ pubsub-
Overrides API endpoint for
gcloud pubsubcommand group. Defaults to https://pubsub.googleapis.com/ recaptchaenterprise-
Overrides API endpoint for
gcloud recaptchacommand group. Defaults to https://recaptchaenterprise.googleapis.com/ recommender-
Overrides API endpoint for
gcloud recommendercommand group. Defaults to https://recommender.googleapis.com/ redis-
Overrides API endpoint for
gcloud rediscommand group. Defaults to https://redis.googleapis.com/ resourcesettings-
Overrides API endpoint for
gcloud resource-settingscommand group. Defaults to https://resourcesettings.googleapis.com/ run-
Overrides API endpoint for
gcloud runcommand group. Defaults to https://run.googleapis.com/ runtimeconfig-
Overrides API endpoint for
gcloud runtime-configcommand group. Defaults to https://runtimeconfig.googleapis.com/ sddc-
Overrides API endpoint for
gcloud vmware sddccommand group. Defaults to https://sddc.googleapis.com/ secretmanager-
Overrides API endpoint for
gcloud secretscommand group. Defaults to https://secretmanager.googleapis.com/ securitycenter-
Overrides API endpoint for
gcloud scccommand group. Defaults to https://securitycenter.googleapis.com/ servicedirectory-
Overrides API endpoint for
gcloud service-directorycommand group. Defaults to https://servicedirectory.googleapis.com/ servicemanagement-
Overrides API endpoint for
gcloud endpointscommand group. Defaults to https://servicemanagement.googleapis.com/ sourcerepo-
Overrides API endpoint for
gcloud sourcecommand group. Defaults to https://sourcerepo.googleapis.com/ spanner-
Overrides API endpoint for
gcloud spannercommand group. For spanner emulator usage, see https://cloud.google.com/spanner/docs/emulator#using_the_gcloud_cli_with_the_emulator speech-
Overrides API endpoint for
gcloud ml speechcommand group. Defaults to https://speech.googleapis.com/ sql-
Overrides API endpoint for
gcloud sqlcommand group. storage-
Overrides API endpoint for
gcloud storagecommand group. Defaults to https://storage.googleapis.com/storage/v1/ testing-
Overrides API endpoint for
gcloud firebase testcommand group. Defaults to https://testing.googleapis.com/ vision-
Overrides API endpoint for
gcloud ml visioncommand group. Defaults to https://vision.googleapis.com/ vmwareengine-
Overrides API endpoint for
gcloud vmwarecommand group. Defaults to https://vmwareengine.googleapis.com/ workflowexecutions-
Overrides API endpoint for
gcloud workflows executionscommand group. Defaults to https://workflowexecutions.googleapis.com/ workflows-
Overrides API endpoint for
gcloud workflowscommand group. Defaults to https://workflows.googleapis.com/
app-
cloud_build_timeout- Timeout, in seconds, to wait for Docker builds to complete during deployments. All Docker builds now use the Cloud Build API.
promote_by_default-
If True, when deploying a new version of a service, that version will be
promoted to receive all traffic for the service. This property can be overridden
with the
--promote-by-defaultor--no-promote-by-defaultflags. stop_previous_version- If True, when deploying a new version of a service, the previously deployed version is stopped. If False, older versions must be stopped manually.
use_runtime_builders- If set, opt in/out to a new code path for building applications using pre-fabricated runtimes that can be updated independently of client tooling. If not set, the default path for each runtime is used.
artifacts-
location-
Default location to use when working with Artifact Registry resources. When a
locationvalue is required but not provided, the command will fall back to this value, if set. If this value is unset, the default location isglobalwhenlocationvalue is optional. repository-
Default repository to use when working with Artifact Registry resources. When a
repositoryvalue is required but not provided, the command will fall back to this value, if set.
auth-
access_token_file- A file path to read the access token. Use this property to authenticate gcloud with an access token. The credentials of the active account (if it exists) will be ignored. The file should contain an access token with no other information.
disable_credentials-
If True,
gcloudwill not attempt to load any credentials or authenticate any requests. This is useful when behind a proxy that adds authentication to requests. impersonate_service_account-
While set, all API requests will be made as the given service account or target
service account in an impersonation delegation chain instead of the currently
selected account. You can specify either a single service account as the
impersonator, or a comma-separated list of service accounts to create an
impersonation delegation chain. This is done without needing to create,
download, or activate a key for the service account or accounts.
In order to make API requests as a service account, your currently selected account must have an IAM role that includes the
iam.serviceAccounts.getAccessTokenpermission for the service account or accounts.The
roles/iam.serviceAccountTokenCreatorrole has theiam.serviceAccounts.getAccessToken permission. You can also create a custom role.You can specify a list of service accounts, separated with commas. This creates an impersonation delegation chain in which each service account delegates its permissions to the next service account in the chain. Each service account in the list must have the
roles/iam.serviceAccountTokenCreatorrole on the next service account in the list. For example, when the property is set throughgcloud config set auth/impersonate_service_account=,SERVICE_ACCOUNT_1, the active account must have theSERVICE_ACCOUNT_2roles/iam.serviceAccountTokenCreatorrole on, which must have theSERVICE_ACCOUNT_1roles/iam.serviceAccountTokenCreatorrole on.SERVICE_ACCOUNT_2is the impersonated service account andSERVICE_ACCOUNT_1is the delegate.SERVICE_ACCOUNT_2 service_account_disable_id_token_refresh- If True, disable ID token refresh for service account.
service_account_use_self_signed_jwt- If True, use self signed jwt flow to get service account credentials access token. This only applies to service account json file and not to the legacy .p12 file.
token_host- Overrides the token endpoint to provision access tokens. It can be used with Private Service Connect.
batch-
location-
Default location to use when working with Batch resources. When a
locationvalue is required but not provided, the command will fall back to this value, if set.
billing-
quota_project-
The Google Cloud project that is billed and charged quota for operations
performed in
gcloud. When unset, the default is [CURRENT_PROJECT]. This default bills and charges quota against the current project. If you need to operate on one project, but need to bill your usage against or use quota from a different project, you can use this flag to specify the billing project. If bothbilling/quota_projectand--billing-projectare specified,--billing-projecttakes precedence.
builds-
kaniko_cache_ttl- TTL, in hours, of cached layers when using Kaniko. If zero, layer caching is disabled.
region-
Default region to use when working with Cloud Build resources. When a
--regionflag is required but not provided, the command will fall back to this value, if set. timeout- Timeout, in seconds, to wait for builds to complete. If unset, defaults to 10 minutes.
use_kaniko-
If True, kaniko will be used to build images described by a Dockerfile, instead
of
docker build.
component_manager-
additional_repositories-
Comma separated list of additional repositories to check for components. This
property is automatically managed by the
gcloud components repositoriescommands. disable_update_check- If True, Google Cloud CLI will not automatically check for updates.
composer-
location- Composer location to use. Each Composer location constitutes an independent resource namespace constrained to deploying environments into Compute Engine regions inside this location. This parameter corresponds to the /locations/<location> segment of the Composer resource URIs being referenced.
compute-
image_family_scope-
Sets how images are selected with image families for disk and instance creation.
By default, zonal image resources are used when using an image family in a
public image project, and global image resources are used for all other
projects. To override the default behavior, set this property to
zonalorglobal. region-
Default region to use when working with regional Compute Engine resources. When
a
--regionflag is required but not provided, the command will fall back to this value, if set. To see valid choices, rungcloud compute regions list. use_new_list_usable_subnets_api- If True, use the new API for listing usable subnets which only returns subnets in the current project.
zone-
Default zone to use when working with zonal Compute Engine resources. When a
--zoneflag is required but not provided, the command will fall back to this value, if set. To see valid choices, rungcloud compute zones list.
container-
build_timeout- Timeout, in seconds, to wait for container builds to complete.
cluster- Name of the cluster to use by default when working with Kubernetes Engine.
use_application_default_credentials- If True, use application default credentials to authenticate to the cluster API server.
use_client_certificate- If True, use the cluster's client certificate to authenticate to the cluster API server.
container_attached-
location- Default Google Cloud location to use for Attached clusters.
container_aws-
location- Default Google Cloud location to use for Anthos clusters on AWS.
container_azure-
location- Default Google Cloud location to use for Anthos clusters on Azure.
container_bare_metal-
location- Default Google Cloud location to use for Anthos clusters on Bare Metal.
container_vmware-
location- Default Google Cloud location to use for Anthos clusters on VMware.
context_aware-
use_client_certificate-
If True, use client certificate to authorize user device using Context-aware
access. This includes user login as well. Some services may not support client
certificate authorization. If a command sends requests to such services, the
client certificate will not be validated. Run
gcloud topic client-certificatefor list of services supporting this feature.
dataflow-
disable_public_ips- Specifies that Cloud Dataflow workers must not use public IP addresses.
enable_streaming_engine- Set this to true to enable Streaming Engine for the job.
print_only- Prints the container spec to stdout. Does not save in Google Cloud Storage.
datafusion-
location- Datafusion location to use. Each Datafusion location constitutes an independent resource namespace constrained to deploying environments into Compute Engine regions inside this location. This parameter corresponds to the /locations/<location> segment of the Datafusion resource URIs being referenced.
datapipelines-
disable_public_ips- Specifies that Cloud Dataflow workers must not use public IP addresses.
enable_streaming_engine- Set this to true to enable Streaming Engine for the job.
dataplex-
asset-
Dataplex asset to use. When an
assetis required but not provided by a flag, the command will fall back to this value, if set. lake-
Dataplex lake to use. When a
lakeis required but not provided by a flag, the command will fall back to this value, if set. location-
Dataplex location to use. When a
locationis required but not provided by a flag, the command will fall back to this value, if set. zone-
Dataplex zone to use. When a
zoneis required but not provided by a flag, the command will fall back to this value, if set.
dataproc-
location- Dataproc location to use. Each Dataproc location constitutes an independent resource namespace constrained to deploying instances into Compute Engine zones inside the location.
region- Dataproc region to use. Each Dataproc region constitutes an independent resource namespace constrained to deploying instances into Compute Engine zones inside the region.
deploy-
delivery_pipeline- Delivery Pipeline being managed by Cloud Deploy.
region- Cloud Deploy region to use. Each Cloud Deploy region constitutes an independent resource namespace constrained to deploying instances into Compute Engine zones inside the region.
deployment_manager-
glob_imports- Enable import path globbing. Uses glob patterns to match multiple imports in a config file.
eventarc-
location-
The default location to use when working with Eventarc resources. This should be
either
or one of the supported regions. When aglobal--locationflag is required but not provided, the command will fall back to this value, if set.
filestore-
location-
Please use the
--locationflag or set the filestore/zone or filestore/region property. region-
Default region to use when working with Cloud Filestore regions. When a
--regionflag is required but not provided, the command will fall back to this value, if set. zone-
Default zone to use when working with Cloud Filestore zones. When a
--zoneflag is required but not provided, the command will fall back to this value, if set.
functions-
gen2-
Default environment to use when working with Cloud Functions resources. When
neither
--gen2nor--no-gen2is provided, the decision of whether to use Generation 2 falls back to this value. region-
Default region to use when working with Cloud Functions resources. When a
--regionflag is required but not provided, the command will fall back to this value, if set. To see valid choices, rungcloud beta functions regions list.
game_services-
default_deployment- Default deployment to use when working with Cloud Game Services list configs. When a --deployment flag is required in a list command but not provided, the command will fall back to this value which envokes aggregated list from the backend.
default_realm- Default realm to use when working with Cloud Game Services list clusters. When a --realm flag is required in a list command but not provided, the command will fall back to this value which envokes aggregated list from the backend.
location-
Default location to use when working with Cloud Game Services resources. When a
--locationflag is required but not provided, the command will fall back to this value.
gcloudignore-
enabled-
If True, do not upload
.gcloudignorefiles (see$ gcloud topic gcloudignore). If False, turn off the gcloudignore mechanism entirely and upload all files.
gkebackup-
backup-
Default backup ID to use when working with Backup for GKE Services resources.
When a
--backupflag is required but not provided, the command will fall back to this value. backup_plan-
Default backup plan ID to use when working with Backup for GKE Services
resources. When a
--backup-planflag is required but not provided, the command will fall back to this value. location-
Default location to use when working with Backup for GKE Services resources.
When a
--locationflag is required but not provided, the command will fall back to this value. restore-
Default restore ID to use when working with Backup for GKE Services resources.
When a
--restoreflag is required but not provided, the command will fall back to this value. restore_plan-
Default restore plan ID to use when working with Backup for GKE Services
resources. When a
--restore-planflag is required but not provided, the command will fall back to this value.
healthcare-
dataset-
Default dataset to use when working with Cloud Healthcare resources. When a
--datasetflag is required but not provided, the command will fall back to this value, if set. location-
Default location to use when working with Cloud Healthcare resources. When a
--locationflag is required but not provided, the command will fall back to this value.
interactive-
bottom_bindings_line- If True, display the bottom key bindings line.
bottom_status_line- If True, display the bottom status line.
- Number of lines in the completion menu.
context- Command context string.
fixed_prompt_position- If True, display the prompt at the same position.
help_lines- Maximum number of help snippet lines.
- If True, expose hidden commands/flags.
justify_bottom_lines- If True, left- and right-justify bottom toolbar lines.
manpage_generator- If True, use the manpage CLI tree generator for unsupported commands.
- If True, display the completions as a multi-column menu.
prompt- Command prompt string.
show_help- If True, show help as command args are being entered.
suggest- If True, add command line suggestions based on history.
lifesciences-
location-
Default location to use when working with Cloud Life Sciences resources. When a
--locationflag is required but not provided, the command will fall back to this value.
looker-
region-
Default region to use when working with Cloud Looker resources. When a
regionis required but not provided by a flag, the command will fall back to this value, if set.
media_asset-
location-
Default location to use when working with Cloud Media Asset resources. When a
--locationflag is required but not provided, the command will fall back to this value.
memcache-
region-
Default region to use when working with Cloud Memorystore for Memcached
resources. When a
regionis required but not provided by a flag, the command will fall back to this value, if set.
metastore-
location-
Default location to use when working with Dataproc Metastore. When a
locationis required but not provided by a flag, the command will fall back to this value, if set. tier-
Default tier to use when creating Dataproc Metastore services. When a
tieris required but not provided by a flag, the command will fall back to this value, if set.Valid values are:
-
developer- The developer tier provides limited scalability and no fault tolerance. Good for low-cost proof-of-concept. -
enterprise- The enterprise tier provides multi-zone high availability, and sufficient scalability for enterprise-level Dataproc Metastore workloads.
-
ml_engine-
local_python-
Full path to the Python interpreter to use for Cloud ML Engine local
predict/train jobs. If not specified, the default path is the one to the Python
interpreter found on system
PATH. polling_interval- Interval (in seconds) at which to poll logs from your Cloud ML Engine jobs. Note that making it much faster than the default (60) will quickly use all of your quota.
netapp-
location-
Default location to use when working with Cloud NetApp Files resources. When a
locationvalue is required but not provided, the command will fall back to this value, if set. region-
Default region to use when working with Cloud NetApp Files regions. When a
--regionflag is required but not provided, the command will fall back to this value, if set.
notebooks-
location-
Default location to use when working with Notebook resources. When a
locationvalue is required but not provided, the command will fall back to this value, if set.
privateca-
location-
Default location to use when working with Private CA resources. When a
--locationflag is required but not provided, the command will fall back to this value, if set.
proxy-
address- Hostname or IP address of proxy server.
password- Password to use when connecting, if the proxy requires authentication.
port- Port to use when connected to the proxy server.
rdns- If True, DNS queries will not be performed locally, and instead, handed to the proxy to resolve. This is default behavior.
type- Type of proxy being used. Supported proxy types are: [http, http_no_tunnel, socks4, socks5].
username- Username to use when connecting, if the proxy requires authentication.
redis-
region-
Default region to use when working with Cloud Memorystore for Redis resources.
When a
regionis required but not provided by a flag, the command will fall back to this value, if set.
run-
cluster- ID of the cluster or fully qualified identifier for the cluster
cluster_location- Zone or region in which the cluster is located.
platform- Target platform for running commands.
region-
Default region to use when working with Cloud Run resources. When a
--regionflag is required but not provided, the command will fall back to this value, if set.
sccsecrets-
locations- A comma separated list of the locations to replicate secrets to. Only applies to secrets with a user-managed policy.
replication-policy- The type of replication policy to apply to secrets. Allowed values are "automatic" and "user-managed". If user-managed then locations must also be provided.
spanner-
instance- Default instance to use when working with Cloud Spanner resources. When an instance is required but not provided by a flag, the command will fall back to this value, if set.
ssh-
putty_force_connect-
Whether or not
gcloudshould automatically accept new or changed host keys when executing plink/pscp commands on Windows. Defaults to True, but can be set to False to present these interactive prompts to the user for host key checking. verify_internal_ip-
Whether or not
gcloudshould perform an initial SSH connection to verify an instance ID is correct when connecting via its internal IP. Without this check,gcloudwill simply connect to the internal IP of the desired instance, which may be wrong if the desired instance is in a different subnet but happens to share the same internal IP as an instance in the current subnet. Defaults to True.
storage-
additional_headers-
Includes arbitrary headers in storage API calls. Accepts a comma separated list
of key=value pairs, e.g.
header1=value1,header2=value2. base_retry_delay- Second delay between retrying operations. May be multiplied by exponential_sleep_multiplier.
check_hashes-
'check_hashes' specifies how strictly to require integrity checking for
downloaded data. Legal values are:
- 'if_fast_else_fail' - (default) Only integrity check if the digest will run efficiently (using compiled code), else fail the download.
- 'if_fast_else_skip' - Only integrity check if the server supplies a hash and the local digest computation will run quickly, else skip the check.
- 'always' - Always check download integrity regardless of possible performance costs.
- 'never' - Don't perform download integrity checks. This setting is not recommended except for special cases such as measuring download performance excluding time for integrity checking.
This option exists to assist users who wish to download a composite object and are unable to install crcmod with the C-extension. CRC32c is the only available integrity check for composite objects, and without the C-extension, download performance can be significantly degraded by the digest computation. This option is ignored for daisy-chain copies, which don't compute hashes but instead (inexpensively) compare the cloud source and destination hashes.
check_mv_early_deletion_fee- Block mv commands that may incur an early deletion fee (the source object in a mv is deleted).
convert_incompatible_windows_path_characters- Allows automatic conversion of invalid path characters on Windows. If not enabled, Windows will raise an OSError if an invalid character is encountered.
copy_chunk_size- Chunk size used for copying to in clouds or on disk.
download_chunk_size- Chunk size used for downloadinging to clouds.
exponential_sleep_multiplier- Used in exponential backoff for retrying operations.
key_store_path-
Path to a yaml file containing an encryption key, and multiple decryption keys
for use in storage commands. The file must be formatted as follows:
encryption_key: {A customer-supplied or customer-managed key.} decryption_keys: - {A customer-supplied key} …Customer-supplied encryption keys must be RFC 4648 section 4 base64-encoded AES256 strings. Customer-managed encryption keys must be of the form
projects/{project}/locations/{location}/keyRings/{key-ring}/cryptoKeys/{crypto-key}. max_retries- Max number of retries for operations like copy.
max_retry_delay- Max second delay between retriable operations.
parallel_composite_upload_compatibility_check- Determines if the GET bucket call should be performed to check if the default storage class and retention period for the destination bucket meet the criteria for parallel composite upload.
parallel_composite_upload_component_size- Specifies the ideal size of a component in bytes, which will act as an upper bound to the size of the components if ceil(file_size / parallel_composite_upload_component_size) is less than the maximum number of objects the API allows composing at once. Values can be provided either in bytes or as human-readable values (e.g., "150M" to represent 150 mebibytes).
parallel_composite_upload_enabled- Determines whether parallel composite upload should be used. Default value is None which will use parallel composite upload and log an appropriate warning for the user explaining that parallel composite upload is being used by default.
parallel_composite_upload_threshold- Specifies the maximum size of a file to upload in a single stream. Files larger than this threshold will be partitioned into component parts, uploaded in parallel, then composed into a single object. The number of components will be the smaller of ceil(file_size / parallel_composite_upload_component_size) and the maximum number of objects the API allows composing at once. For Cloud Storage this limit is 32. This property has no effect if parallel_composite_upload_enabled is set to False.
process_count- The maximum number of processes parallel execution should use. When process_count and thread_count are both 1, commands use sequential execution.
resumable_threshold- File operations above this size in bytes will use resumable instead of one-shot strategies. For example, a resumable download.
s3_endpoint_url- If set, boto3 client will connect to this endpoint. Otherwise, boto3 selects a default endpoint based on the AWS service used.
sliced_object_download_component_size- Target size and upper bound for files to be sliced into. Analogous to parallel_composite_upload_component_size.
sliced_object_download_max_components- Specifies the maximum number of slices to be used when performing a sliced object download. Set None for no limit.
sliced_object_download_threshold- Slice files larger than this value. Zero will block sliced downloads. Analogous to parallel_composite_upload_threshold.
suggest_transfer- If True, logs messages about when Storage Transfer Service might be a better tool than gcloud storage.
thread_count- The number of threads parallel execution should use per process. When process_count and thread_count are both 1, commands use sequential execution.
tracker_files_directory- Directory path to tracker files for resumable operations.
upload_chunk_size- Chunk size used for uploading to clouds.
use_gcloud_crc32c- If True, data integrity checks use a binary subprocess to calculate CRC32C hashes with the included gcloud-crc32c tool rather than the google-crc32c Python library. This behavior is also triggered when the google-crc32c Python library is unavailable even if this property is False.
use_gsutil- If True, use the deprecated upload implementation which uses gsutil.
use_magicfile-
If True, uses the
file --mime <filename>command to guess content types instead of the default filename extension-based mechanism. Available on UNIX and macOS (and possibly on Windows, if you're running Cygwin or some other package that provides implementations of UNIX-like commands). When available and enabled use_magicfile should be more robust because it analyzes file contents in addition to extensions. use_threading_local- If True, reuses some resource if they are already declared on a thread. If False, creates duplicates of resources like API clients on the same thread. Turning off can help with some bugs but will hurt performance.
survey-
disable_prompts- If True, gcloud will not prompt you to take periodic usage experience surveys.
vmware-
region-
Default region to use when working with VMware Engine resources. When a
--regionflag is required but not provided, the command will fall back to this value, if set.
- NOTES
-
These variants are also available:
gcloud alpha config listgcloud beta config list
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-01-31 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]